Repository navigation
Clean up stale documentation and references - #3106
Merged
Merged
Conversation
There is no top-level tests directory, so pytest -s tests found nothing; point to dpnp/tests and to --pyargs dpnp.tests instead. Pass --no-build-isolation to the editable install, as build_locally.py does, mention that build_locally.py also works on Windows, and add the blank line a code-block needs to render.
doc/reference/index.rst listed 14 pages that do not exist. Also mark the polynomials placeholder page as orphan, since routines.rst leaves it out on purpose. Both produced Sphinx warnings.
Remove the unused Windows-IntelLLVM_3.22.cmake, update the docstring template to the layout dpnp docstrings use, and replace the dpctl.tensor references left in dpnp/tensor with dpnp.tensor.
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
October 15, 2026 10:32
antonwolfy
added a commit
that referenced
this pull request
Oct 15, 2026
doc/docstring_template.py is current again, dpnp/tensor no longer mentions dpctl.tensor, and placeholder pages are marked :orphan:.
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
Collaborator
|
Coverage is 82.616% — docs-cleanup into master. No base build found for |
Contributor
|
Array API standard conformance tests for dpnp=0.21.0dev15=np2py314h8d9cdd5_6 ran successfully. |
vlad-perevezentsev
approved these changes
Oct 19, 2026
vlad-perevezentsev
left a comment
vlad-perevezentsev
left a comment
Contributor
There was a problem hiding this comment.
LGTM
Thank you @antonwolfy
github-actions Bot
added a commit
that referenced
this pull request
Oct 19, 2026
This PR cleans up stale documentation and references, one commit per change: 1. **Quick start guide.** The testing section suggested `pytest -s tests`, but there is no top-level `tests` directory; it now gives `python -m pytest dpnp/tests` for the source tree and `python -m pytest --pyargs dpnp.tests` for an installed package. The scikit-build recipes now pass `--no-build-isolation` to `pip install -e .`, as `scripts/build_locally.py` does, so pip doesn't rebuild the package in an isolated environment with build dependencies from PyPI. The guide now says the driver script works on Linux and Windows, and a `code-block` that didn't render because it had no blank line before its content is fixed. 2. **API reference toctree.** `doc/reference/index.rst` listed 14 pages that don't exist (`special`, `sparse`, `ndimage`, `generic`, `memory`, `cuda`, `memoize`, `kernel`, `optimize`, `interoperability`, `testing`, `prof`, `environment`, `misc`); they are removed. `doc/reference/polynomials.rst`, a placeholder whose entries are all commented out and which `routines.rst` leaves out on purpose, is marked `:orphan:`. Both produced Sphinx warnings. 3. **Stale files and references.** - `.github/workflows/Windows-IntelLLVM_3.22.cmake` is removed: nothing uses it, and `conda-recipe/bld.bat` applies only the 3.26 copy. - `doc/docstring_template.py` described a fallback to NumPy and an array printing format that no longer exist; it now shows the docstring layout dpnp uses. - The 110 `dpctl.tensor` references left in `dpnp/tensor` docstrings and comments now say `dpnp.tensor`. Every referenced name exists in `dpnp.tensor`; on the same lines, `:module:` is fixed to `:mod:` and a misspelled `usm_ndarrays` to `usm_ndarray`. 30b894b
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR cleans up stale documentation and references, one commit per change:
pytest -s tests, but there is no top-leveltestsdirectory; it now givespython -m pytest dpnp/testsfor the source tree andpython -m pytest --pyargs dpnp.testsfor an installed package. The scikit-build recipes now pass--no-build-isolationtopip install -e ., asscripts/build_locally.pydoes, so pip doesn't rebuild the package in an isolated environment with build dependencies from PyPI. The guide now says the driver script works on Linux and Windows, and acode-blockthat didn't render because it had no blank line before its content is fixed.doc/reference/index.rstlisted 14 pages that don't exist (special,sparse,ndimage,generic,memory,cuda,memoize,kernel,optimize,interoperability,testing,prof,environment,misc); they are removed.doc/reference/polynomials.rst, a placeholder whose entries are all commented out and whichroutines.rstleaves out on purpose, is marked:orphan:. Both produced Sphinx warnings..github/workflows/Windows-IntelLLVM_3.22.cmakeis removed: nothing uses it, andconda-recipe/bld.batapplies only the 3.26 copy.doc/docstring_template.pydescribed a fallback to NumPy and an array printing format that no longer exist; it now shows the docstring layout dpnp uses.dpctl.tensorreferences left indpnp/tensordocstrings and comments now saydpnp.tensor. Every referenced name exists indpnp.tensor; on the same lines,:module:is fixed to:mod:and a misspelledusm_ndarraystousm_ndarray.